MarkLogic Server 11.0 Product DocumentationPUT /manage/v2/protected-collections/properties?collection={collection-uri}
Summary
This resource address can be used to update the properties for the specified protected collection.
| URL Parameters | |
|---|---|
| uri | The URI of the protected collection. |
| format | The format of the posted data. Can be either
json (default) or xml. This value overrides the Accept header if
both are present. |
| Response Headers | |
|---|---|
| Content-type | The MIME type of the data in the response
body. Depending upon the value of the format parameter or Accept header, either
application/xml or application/json. |
Response
Upon success, MarkLogic Server returns status code 204 (No Content). If the payload is malformed or the protected collection does not exist, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.
Required Privileges
This operation requires one of the following:- the
manage-adminandsecurityrole - the following privileges:
http://marklogic.com/xdmp/privileges/managehttp://marklogic.com/xdmp/privileges/manage-adminhttp://marklogic.com/xdmp/privileges/collection-get-permissions
Usage Notes
The properties that can be modified are listed here.
Note: The properties described here are for XML payloads. In general they are the same for
JSON, with the exception that, in JSON, permissions is expressed in singular
form. For example, in JSON, permissions is instead permission and
the format is: "permission":[{"role-name":"name", "capability":"cap"}].
collectionpermissionsThis is a complex structure with the following children:
permissionThis is a complex structure with the following children:
role-namecapability
Example
curl -X PUT --anyauth -u admin:admin -H "Content-Type:application/json" \
-d '{"permissions": [{"role-name": "view-admin","capability": "read"}]}' \
http://localhost:8002/manage/v2/protected-collections/properties?collection=http://example.org
==> Changes the permissions for the "http://example.org" protected collection.